Skip to content

Conversation

@MarcSkovMadsen
Copy link
Contributor

@MarcSkovMadsen MarcSkovMadsen commented Nov 23, 2025

The README contains a lot of examples. But there are no visualization, i.e. users cannot see what this really is.

This PR adds the missing visualizations.

Please note some of the code examples will have to be adjusted to look attractive and be useful.

You can preview the updated README here.

@codecov
Copy link

codecov bot commented Nov 23, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 76.23%. Comparing base (82d0c21) to head (b6c58ed).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #14   +/-   ##
=======================================
  Coverage   76.23%   76.23%           
=======================================
  Files           3        3           
  Lines         101      101           
=======================================
  Hits           77       77           
  Misses         24       24           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This pull request adds visualizations to the README documentation by including PNG images and GIF animations for each code example. The changes make the documentation more user-friendly by showing what the examples actually look like when rendered. Key updates include:

  • Added 9 image files (8 PNGs, 1 GIF reference) to visualize examples
  • Updated all code examples with improved styling parameters (margins, sizing modes, dimensions)
  • Added image references after each example section

Reviewed changes

Copilot reviewed 1 out of 11 changed files in this pull request and generated 4 comments.

File Description
README.md Updated code examples with better styling and added image references for visualizations; contains 3 spelling errors and 1 misleading comment
docs/assets/images/*.png New PNG image files for visualizing examples (binary files, cannot review content directly)

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@MarcSkovMadsen
Copy link
Contributor Author

MarcSkovMadsen commented Nov 28, 2025

Note. I've changed show_buttons default value to False closing #17 .

This PR should be ready to review.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@philippjfr philippjfr merged commit 6952c81 into main Nov 28, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants